/**
 * Copyright (c) 2007-2008, the original author(s)
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Prana Framework nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.pranaframework.ioc.factory.xml.parser {
	
	/**
	 * Defines a single node parser.
	 * 
	 * @author Christophe Herreman
	 * @author Erik Westra
	 */
	public interface INodeParser {
		/**
		 * Determines if the given node can be parsed.
		 * 
		 * @param node	The node to be checked.
		 * 
		 * @return true if this implementation can parse the given node.
		 */
		function canParse(node:XML):Boolean;
		
		/**
		 * Will parse the given node. The type of the result depends 
		 * on the implementation of the node parser.
		 * 
		 * @param node	The node that will be parsed
		 * 
		 * @return the parsed node
		 */
		function parse(node:XML):Object;
		
		/**
		 * Will add an alias that this node parser will react upon. It has direct influence 
		 * on the result of the canParse method.
		 * 
		 * @param alias		Alternative nodename that can be parsed by this parser
		 * 
		 * @see #canParse
		 */
		function addNodeNameAlias(alias:String):void;
		
		/**
		 * Return an array containing the node names this parser can parse
		 */
		function getNodeNames():Array;
	}
}